[TS Migration] Migrate 'ReportUtils.js' lib to TypeScript #29012

kubabutkiewicz · 2023-10-06T15:38:40Z

Details

Fixed Issues

$ #24927

Tests

Verify that no errors appear in the JS console

Offline tests

QA Steps

Send Money Request
Verify that all things (like removing, editing, displaying) related to Money Request works
Create a chat with 1 user
Verify that all things related to that is working
Create chat with multiple users
Verify that all things related to that is working
Assign a task
Verify that all things related to that is working

Verify that no errors appear in the JS console

PR Author Checklist

I linked the correct issue in the ### Fixed Issues section above
I wrote clear testing steps that cover the changes made in this PR
- I added steps for local testing in the Tests section
- I added steps for the expected offline behavior in the Offline steps section
- I added steps for Staging and/or Production testing in the QA steps section
- I added steps to cover failure scenarios (i.e. verify an input displays the correct error message if the entered data is not correct)
- I turned off my network connection and tested it while offline to ensure it matches the expected behavior (i.e. verify the default avatar icon is displayed if app is offline)
- I tested this PR with a High Traffic account against the staging or production API to ensure there are no regressions (e.g. long loading states that impact usability).
I included screenshots or videos for tests on all platforms
I ran the tests on all platforms & verified they passed on:
- Android / native
- Android / Chrome
- iOS / native
- iOS / Safari
- MacOS / Chrome / Safari
- MacOS / Desktop
I verified there are no console errors (if there's a console error not related to the PR, report it or open an issue for it to be fixed)
I followed proper code patterns (see Reviewing the code)
- I verified that any callback methods that were added or modified are named for what the method does and never what callback they handle (i.e. toggleReport and not onIconClick)
- I verified that the left part of a conditional rendering a React component is a boolean and NOT a string, e.g. myBool && <MyComponent />.
- I verified that comments were added to code that is not self explanatory
- I verified that any new or modified comments were clear, correct English, and explained "why" the code was doing something instead of only explaining "what" the code was doing.
- I verified any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
  - If any non-english text was added/modified, I verified the translation was requested/reviewed in #expensify-open-source and it was approved by an internal Expensify engineer. Link to Slack message:
- I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
- I verified any copy / text that was added to the app is grammatically correct in English. It adheres to proper capitalization guidelines (note: only the first word of header/labels should be capitalized), and is approved by marketing by adding the Waiting for Copy label for a copy review on the original GH to get the correct copy.
- I verified proper file naming conventions were followed for any new files or renamed files. All non-platform specific files are named after what they export and are not named "index.js". All platform-specific files are named for the platform the code supports as outlined in the README.
- I verified the JSDocs style guidelines (in STYLE.md) were followed
If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
I followed the guidelines as stated in the Review Guidelines
I tested other components that can be impacted by my changes (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar are working as expected)
I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
I verified any variables that can be defined as constants (ie. in CONST.js or at the top of the file that uses the constant) are defined as such
I verified that if a function's arguments changed that all usages have also been updated correctly
If a new component is created I verified that:
- A similar component doesn't exist in the codebase
- All props are defined accurately and each prop has a /** comment above it */
- The file is named correctly
- The component has a clear name that is non-ambiguous and the purpose of the component can be inferred from the name alone
- The only data being stored in the state is data necessary for rendering and nothing else
- If we are not using the full Onyx data that we loaded, I've added the proper selector in order to ensure the component only re-renders when the data it is using changes
  - Any internal methods bound to this are necessary to be bound (i.e. avoid this.submit = this.submit.bind(this); if this.submit is never passed to a component event handler like onClick)
- All JSX used for rendering exists in the render method
- The component has the minimum amount of code necessary for its purpose, and it is broken down into smaller components in order to separate concerns and functions
If any new file was added I verified that:
- The file has a description of what it does and/or why is needed at the top of the file if the code is not self explanatory
If a new CSS style is added I verified that:
- A similar style doesn't already exist
- The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(themeColors.componentBG))
If the PR modifies code that runs when editing or sending messages, I tested and verified there is no unexpected behavior for all supported markdown - URLs, single line code, code blocks, quotes, headings, bold, strikethrough, and italic.
If the PR modifies a generic component, I tested and verified that those changes do not break usages of that component in the rest of the App (i.e. if a shared library or component like Avatar is modified, I verified that Avatar is working as expected in all cases)
If the PR modifies a component related to any of the existing Storybook stories, I tested and verified all stories for that component are still working as expected.
If the PR modifies a component or page that can be accessed by a direct deeplink, I verified that the code functions as expected when the deeplink is used - from a logged in and logged out account.
If a new page is added, I verified it's using the ScrollView component to make it scrollable when more elements are added to the page.
If the main branch was merged into this PR after a review, I tested again and verified the outcome was still expected according to the Test steps.
I have checked off every checkbox in the PR author checklist, including those that don't apply to this PR.

Screenshots/Videos

Web

web.mp4

Mobile Web - Chrome

Mobile Web - Safari

Desktop

desktop.mp4

iOS

ios.mp4

Android

android.mp4

src/libs/ReportUtils.ts

…s-migration/ReportUtils-lib

src/types/onyx/Session.ts

src/types/onyx/Report.ts

src/libs/ReportUtils.ts

…ixes

…s-migration/ReportUtils-lib

src/libs/ReportActionsUtils.ts

src/libs/ReportUtils.ts

src/libs/TransactionUtils.ts

mountiny · 2023-11-24T15:09:39Z

But if possible, can we have QA from someone else, too (maybe Applause) before merging this PR so no regression might occur from this?

The problem is that Applause will take couple days and in the meantime there will be bunch of deploy blockers, I think with this kind of PR we need to bite the bullet and get it merged and fix on main/ staging as people notice some issues.

shubham1206agra · 2023-11-24T15:56:00Z

Ok then

kubabutkiewicz · 2023-11-24T16:39:58Z

@nkuoch all yours 🙏

src/libs/ReportUtils.ts

nkuoch · 2023-11-24T20:25:24Z

src/libs/ReportUtils.ts

    });
 }

+function isReportDraft(report: OnyxEntry<Report>): boolean {
+    return isExpenseReport(report) && report?.stateNum === CONST.REPORT.STATE_NUM.OPEN && report.statusNum === CONST.REPORT.STATUS.OPEN;


Suggested change

return isExpenseReport(report) && report?.stateNum === CONST.REPORT.STATE_NUM.OPEN && report.statusNum === CONST.REPORT.STATUS.OPEN;

return isExpenseReport(report) && report.stateNum === CONST.REPORT.STATE_NUM.OPEN && report.statusNum === CONST.REPORT.STATUS.OPEN;

@nkuoch we need to have optional chaining here because report could be null

isExpenseReport is already making sure report is not null ... but I guess lint is complaining if you don't?

Yeah , thats true

luacmartins · 2023-11-24T22:53:51Z

The problem is that Applause will take couple days and in the meantime there will be bunch of deploy blockers, I think with this kind of PR we need to bite the bullet and get it merged and fix on main/ staging as people notice some issues.

I think in this case it's better to have an ad hoc build tested for this and handle conflicts as they come. If we merge this PR and there are blockers, it's likely that a revert won't be easy because of conflicts and then we'd be blocking the deploy until we fix all issues.

…s-migration/ReportUtils-lib

kubabutkiewicz · 2023-11-27T09:24:41Z

@nkuoch done, could you recheck? 🙏

…s-migration/ReportUtils-lib

kubabutkiewicz · 2023-11-27T13:27:34Z

@nkuoch conflicts resolved 🙏

OSBotify · 2023-11-27T14:43:17Z

✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release.

OSBotify · 2023-11-27T19:22:19Z

🚀 Deployed to staging by https://github.com/nkuoch in version: 1.4.4-0 🚀

platform	result
🤖 android 🤖	success ✅
🖥 desktop 🖥	success ✅
🍎 iOS 🍎	success ✅
🕸 web 🕸	success ✅

danieldoglas · 2023-11-28T18:02:24Z

Hi @kubabutkiewicz , this migration generated this issue: #32111

OSBotify · 2023-11-29T11:44:55Z

🚀 Deployed to production by https://github.com/mountiny in version: 1.4.4-3 🚀

platform	result
🤖 android 🤖	success ✅
🖥 desktop 🖥	success ✅
🍎 iOS 🍎	success ✅
🕸 web 🕸	success ✅

paultsimura · 2023-12-01T08:19:42Z

src/libs/ReportUtils.ts

+    const longName = personalDetails.displayName ? personalDetails.displayName : formattedLogin;
+
+    const shortName = personalDetails.firstName ? personalDetails.firstName : longName;


@kubabutkiewicz I saw you tried the optional chaining first: personalDetails.displayName ?? formattedLogin. Was there any issue with using that approach? I suppose it showed the empty line if personalDetails.displayName was such?

Empty strings will create problems.

Is there any drawback to using just const longName = personalDetails.displayName || formattedLogin?

|| is not allowed on strings

Correct in js, but will throw type errors in ts

Thanks. I didn't know it was a TS-specific thing 👍

I think I am not needed here any more 😄 Thanks @shubham1206agra

aimane-chnaif · 2023-12-05T19:06:08Z

src/libs/ReportUtils.ts

-    return lodashGet(allPolicies, [`${ONYXKEYS.COLLECTION.POLICY}${report.policyID}`, 'avatar']) || getDefaultWorkspaceAvatar(workspaceName);
+function getWorkspaceAvatar(report: OnyxEntry<Report>): UserUtils.AvatarSource {
+    const workspaceName = getPolicyName(report, false, allPolicies?.[`${ONYXKEYS.COLLECTION.POLICY}${report?.policyID}`]);
+    return allPolicies?.[`policy${report?.policyID}`]?.avatar ?? getDefaultWorkspaceAvatar(workspaceName);


This was overlooked. ONYXKEYS.COLLECTION.POLICY = policy_ (_ at the end) so below is the correct change:

Suggested change

return allPolicies?.[`policy${report?.policyID}`]?.avatar ?? getDefaultWorkspaceAvatar(workspaceName);

return allPolicies?.[`policy_${report?.policyID}`]?.avatar ?? getDefaultWorkspaceAvatar(workspaceName);

As this is still within regression period, @kubabutkiewicz are you able to fix #32507?

This is really borderline time. I don't know if the regression period is over or not in this case.

Technically not over yet (6 days 7 hrs 😄)
I don't suggest to apply any penalty here since it was big PR.
But this minor issue can be fixed as follow-up.

@aimane-chnaif sure will create a PR today

youssef-lr · 2024-01-02T22:43:04Z

src/libs/ReportUtils.ts

    const report = getReport(reportID);
+    if (!report || !isNotEmptyObject(report)) {


Any reason why we're using !isNotEmptyObject instead of isEmptyObject?

Better type narrowing

I think isEmptyObject has the same type narrowing capabilities. @youssef-lr it may be a mistake, isEmptyObject seems better

aimane-chnaif · 2024-01-04T04:24:58Z

src/libs/ReportUtils.ts

+            if (!report?.participantAccountIDs) {
+                return false;
+            }
+            const sortedParticipanctsAccountIDs = report.parentReportActionIDs?.sort();


This was overlooked.

Suggested change

const sortedParticipanctsAccountIDs = report.parentReportActionIDs?.sort();

const sortedParticipanctsAccountIDs = report.participantAccountIDs.sort();

Before migration: _.sortBy(report.participantAccountIDs)

kubabutkiewicz added 6 commits October 3, 2023 13:44

ref: started migrating ReportUtils to TS

4187fbb

Merge branch 'main' into ts-migration/ReportUtils-lib

29e9656

ref: continue to migrate ReportUtils to Ts

acaa8ea

Merge branch 'main' into ts-migration/ReportUtils-lib

18ad8ea

ref: ReportUtils continue of migration

73d6d6e

ref: keep migrating ReportUtils

e9ddcbe

VickyStash reviewed Oct 9, 2023

View reviewed changes

kubabutkiewicz added 8 commits October 10, 2023 08:07

Merge branch 'main' into ts-migration/ReportUtils-lib

8eb1c13

fix: merge conflicts, few adjustments

dfffe5f

fix: ts fixes for ReportUtils

4ad36b4

Merge branch 'main' of github.com:kubabutkiewicz/expensify-app into t…

9e35d4b

…s-migration/ReportUtils-lib

fix: ts errors

a36ff94

fix: fixing type issues

ba218c5

fix: added some return types

57b42e8

Merge branch 'main' of github.com:kubabutkiewicz/expensify-app into t…

d52f919

…s-migration/ReportUtils-lib

blazejkustra suggested changes Oct 23, 2023

View reviewed changes

VickyStash reviewed Oct 23, 2023

View reviewed changes